Interface ModuleFactory

All Superinterfaces:
IPCObject
All Known Implementing Classes:
ModuleFactoryImpl

public interface ModuleFactory extends IPCObject
Information provided by the PKI file:

    \class ModuleFactory
    
    \brief Factory for modules.
    
Author:
Auto-generated
  • Method Details

    • getDescriptor

      ModuleDescriptor getDescriptor(ModuleType type, String model)
      Information provided by the PKI file:
      
          \brief Gets the module descriptor that matches the given types.
          
          \param moduleType ModuleType, the number of the module.
          Types: eLineCard = 0,
          eNetworkModule = 1,
          eInterfaceCard = 2,
          ePtRouterModule = 3,
          ePtSwitchModule = 4,
          ePtCloudModule = 5,
          ePtRepeaterModule = 6,
          ePtHostModule = 7,
          ePtModemModule = 8,
          ePtLaptopModule = 9,
          ePtTVModule = 10,
          eIpPhonePowerAdapter = 11,
          ePtTabletPCModule = 12,
          ePtPdaModule = 13,
          ePtWirelessEndDeviceModule = 14,
          ePtWiredEndDeviceModule = 15,
          eTrs35 = 16,
          eUsb = 17,
          eNonRemovableModule = 18,
          eASAModule = 19,
          eASAPowerAdapter = 20,
          ePtCellTowerModule = 21,
          ePtIoeModule = 22,
          ePtIoeNetworkModule = 23,
          ePtIoeAnalogModule = 24,
          ePtIoeDigitalModule = 25,
          ePtIoeCustomIOModule = 26,
          ePtIoePowerAdapter = 27,
          ePtIoeMcuComponentPowerAdapter = 28,
          ePtRouterPowerAdapter = 29,
          eSfpModule = 30,
          eAccessPointPowerAdaptor = 31,
          eNonRemovableInterfaceCard = 32,
          eCustomModuleType = 2000
          \param model, model name.  Something like "PT-ROUTER-NM-1CFE".
          
          \return ModuleDescriptor, the descriptor that matches the given types.
          
              
      Parameters:
      type - Takes in a parameter of type
      model - Takes in a parameter of model
      Returns:
      ModuleDescriptor Returns a ModuleDescriptor
    • getAvailableModuleCount

      int getAvailableModuleCount()
      Information provided by the PKI file:
      
          \brief Gets the number of module descriptors stored in the factory.
          
          \return int, the number of module descriptors stored in the factory.
          
              
      Returns:
      int Returns a int
    • getAvailableModuleAt

      ModuleDescriptor getAvailableModuleAt(int index)
      Information provided by the PKI file:
      
          \brief Gets the module descriptor at the given index.
          
          \param int, index to get the descriptor from.  Range (0, getAvailableModuleCount()-1)
          
          \return ModuleDescriptor, the descriptor at the given index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      ModuleDescriptor Returns a ModuleDescriptor
    • getAvailableModuleForTypeCount

      int getAvailableModuleForTypeCount(ModuleType type)
      Information provided by the PKI file:
      
          \brief Gets the number of module descriptors stored in the factory of the given type.
          
          \param type, module type to check for.
          
          \return int, the number of module descriptors stored in the factory of the given type.
          
              
      Parameters:
      type - Takes in a parameter of type
      Returns:
      int Returns a int
    • getAvailableModuleForTypeAt

      ModuleDescriptor getAvailableModuleForTypeAt(ModuleType type, int index)
      Information provided by the PKI file:
      
          \brief Gets the module descriptor stored for the given type and index.
          
          \param type, module type to check for.
          \param index, index in they type to get the descriptor for.
          
          \return ModuleDescriptor, the module descriptor stored for the given type and index.
          
              
      Parameters:
      type - Takes in a parameter of type
      index - Takes in a parameter of index
      Returns:
      ModuleDescriptor Returns a ModuleDescriptor
    • addModuleModel

      ModuleDescriptor addModuleModel(ModuleType type, String model)
      Information provided by the PKI file:
      
          \brief Adds a module descriptor of the given types.
          
          \param type, module type to add.
          \param model, the string type of for the module.  Something like "PT-ROUTER-NM-1CFE".
          
          \return ModuleDescriptor, the module descriptor added.
          
              
      Parameters:
      type - Takes in a parameter of type
      model - Takes in a parameter of model
      Returns:
      ModuleDescriptor Returns a ModuleDescriptor